WPS 基础接口 > 表格 API 参考 > AddIn > AddIn 对象

代表单个加载宏,不论该加载宏是否已加载。

说明

AddIn 对象是 AddIns 集合的成员。AddIns 集合包含 ET 所有可用加载宏的列表(不论这些加载宏是否已安装)。此列表与“加载宏”对话框中显示的加载宏列表对应。

示例

使用 AddIns(index)(其中 index 是加载宏标题或索引号)可返回单个 AddIn 对象。下例安装“分析工具库”加载宏。

示例代码
AddIns.Item("analysis toolpak").Installed = true

请勿混淆加载宏标题(出现在“加载宏”对话框中)与加载宏名称(加载宏的文件名)。必须严格按照“加载宏”对话框中的标题书写加载宏标题,但不必匹配大小写。

加载宏索引号代表加载宏在“加载宏”对话框内“可用加载宏”框中的位置。下例创建一个列表,包含可用加载宏的指定属性。

示例代码
let sheet = Worksheets.Item("Sheet1")
sheet.Rows.Item(1).Font.Bold = true
sheet.Range("a1:d1").Value2 = ["Name", "Full Name", "Title", "Installed"]
for(let i = 1; i <= AddIns.Count; i++) {
    sheet.Cells(i + 1, 1).Value2 = AddIns.Item(i).Name
    sheet.Cells(i + 1, 2).Value2 = AddIns.Item(i).FullName
    sheet.Cells(i + 1, 3).Value2 = AddIns.Item(i).Title
    sheet.Cells(i + 1, 4).Value2 = AddIns.Item(i).Installed
}
sheet.Range("a1").CurrentRegion.Columns.AutoFit()

Add 方法将加载宏添加到可用加载宏列表中,但不安装加载宏。将加载宏的 Installed 属性设为 True 可安装加载宏。要安装可用加载宏列表中没有的加载宏,必须先使用 Add 方法,然后设置 Installed 属性。此操作一步即可完成,如下例中所示(注意,Add 方法中应使用加载宏的名称,而不使用标题)。

示例代码
AddIns.Add("generic.xll").Installed = true

使用 Workbooks(index)(其中 index 是加载宏文件名而非标题)可返回对与某一加载宏相对应的工作簿的引用。因为加载宏通常不出现在 Workbooks 集合中,所以必须使用其文件名来指定。此示例将变量 wb 设置为 Myaddin.xla 的工作簿。

示例代码
let wb = Workbooks.Item("myaddin.xla")

下例将变量 wb 设置为“分析工具库”加载宏的工作簿。

示例代码
let wb = Workbooks.Item(AddIns.Item("analysis toolpak").Name)

如果 Installed 属性为 True,但调用加载宏中的函数仍旧失败,那么可能并未真正地加载了该加载宏。这是因为 Addin 对象代表了加载宏的存在及安装状态,但并不代表加载宏工作簿中的实际内容。为保证已安装的加载宏被加载,应当打开该加载宏工作簿。下例中,如果加载宏“My Addin”未出现在 Workbooks 集合中,就打开该加载宏。

示例代码
try {    
    // turn off error checking
    let wbMyAddin = Workbooks.Item(AddIns.Item("My Addin").Name)
    let lastError = Err
}
catch(exception) {
    if(lastError != 0) {
        // the add-in workbook isn't currently open. Manually open it.
        let wbMyAddin = Workbooks.Open(AddIns.Item("My Addin").FullName)
    }
}


请参阅